<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
    <title>Read Operator</title>
    <link rel="stylesheet" href="../style.css">
</head>
<body>
<table class="header">
    <tr class="header">
        <td class="header">&nbsp;Read Operator</td>
        <td class="header" align="right">
            <a href="nbdocs://org.esa.snap.snap.help/org/esa/snap/snap/help/docs/general/overview/SnapOverview.html">
                <img src="images/snap_header.jpg" border="0"/></a>
        </td>
    </tr>
</table>
<h1>Read Operator Description</h1>
<h2>Overview</h2>
<table>
  <tr><td><b>Name:</b></td><td><code>Read</code></td></tr>
  <tr><td><b>Full name:</b></td><td><code>org.esa.snap.core.gpf.common.ReadOp</code></td></tr>
  <tr><td><b>Purpose:</b></td><td>Reads a data product from a given file location.</td></tr>
  <tr><td><b>Version:</b></td><td>1.2</td></tr>
</table>
<h2>Description</h2>
Reads the specified file as product. This operator may serve as a source node in processing graphs,
 especially if multiple data products need to be read in.
 <p>
 Here is a sample of how the <code>Read</code> operator can be integrated as a node within a processing graph:
 <pre>
    &lt;node id="readNode"&gt;
        &lt;operator&gt;Read&lt;/operator&gt;
        &lt;parameters&gt;
            &lt;file&gt;/eodata/SST.nc&lt;/file&gt;
            &lt;formatName&gt;GeoTIFF&lt;/formatName&gt;
        &lt;/parameters&gt;
    &lt;/node&gt;
 </pre>
<h2>Sources</h2>
<p><i>This operator does not have any sources.</i>
<h2>Parameters</h2>
<table>
<tr>
  <th>Name</th>
  <th>Data Type</th>
  <th>Default</th>
  <th>Description</th>
  <th>Constraints</th>
</tr>
<tr>
  <td><code>file</code></td>
  <td><code>File</code></td>
    <td><code></code></td>
    <td>The file from which the data product is read.</td>
    <td>not null; non empty</td>
</tr>
    <tr>
        <td><code>formatName</code></td>
        <td><code>String</code></td>
        <td><code></code></td>
        <td>An (optional) format name.</td>
        <td>non empty</td>
    </tr>
    <tr>
        <td><code>sourceBands</code></td>
        <td><code>String[]</code></td>
        <td><code></code></td>
        <td>The list of source bands.</td>
        <td></td>
    </tr>
    <tr>
        <td><code>sourceMasks</code></td>
        <td><code>String[]</code></td>
        <td><code></code></td>
        <td>The list of source masks.</td>
        <td></td>
    </tr>
    <tr>
        <td><code>pixelRegion</code></td>
        <td><code>Rectangle</code></td>
        <td><code></code></td>
        <td>The subset region in pixel coordinates.
            Use the following format:
            <x>,
                <y>,
                    <width>,
                        <height>
                            If not given, the entire scene is used. The 'geoRegion' parameter has precedence over this
                            parameter.
        </td>
        <td></td>
    </tr>
    <tr>
        <td><code>geometryRegion</code></td>
        <td><code>Geometry</code></td>
        <td><code></code></td>
        <td>The subset region in geographical coordinates using WKT-format,
            e.g. POLYGON((
            <lon1>
                <lat1>,
                    <lon2>
                        <lat2>, ...,
                            <lon1>
                                <lat1>))
                                    (make sure to quote the option due to spaces in
                                    <geometry>).
                                        If not given, the entire scene is used.
        </td>
        <td></td>
    </tr>
    <tr>
        <td><code>copyMetadata</code></td>
        <td><code>boolean</code></td>
        <td><code>true</code></td>
        <td>Whether to copy the metadata of the source product.</td>
        <td></td>
    </tr>
</table>
<hr/>
</body>
</html>
